/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.util;

import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject;

/** This is a utility class which performs several functions related to the
    transfer of XmlContent between elements.

    @author Shrideep Pallickara
    $Date: 2004/12/27 04:02:50 $ 
    $Revision: 1.3 $
*/


public class XmlContentTransfer {
  
  private static final XmlContentTransfer instance = new XmlContentTransfer();
  private String moduleName = "XmlContentTransfer: ";
  
  
  private XmlContentTransfer() {}

  /** Get instance */
  public static XmlContentTransfer getInstance() {
    return instance;
  }

  /** Copy the Xml Contents from the source to the destination. Note that this
      method also positions the destination cursor at the right location prior
      to the actual copy.*/
  public void copyFromSourceToDestination(XmlObject source, 
					  XmlObject destination) {
    XmlCursor sourceCursor = source.newCursor();
    XmlCursor destinationCursor = destination.newCursor();
    
    destinationCursor.toNextToken();
    copyFromSourceToDestination(sourceCursor, destinationCursor);
    sourceCursor.dispose();
    destinationCursor.dispose();
  }


  /** Copy the Xml Contents from the source to the destination.*/
  public void copyFromSourceToDestination(XmlObject source, 
					  XmlCursor destinationCursor) {
    XmlCursor sourceCursor = source.newCursor();
    
    copyFromSourceToDestination(sourceCursor, destinationCursor);
    sourceCursor.dispose();
  }
  
  
  
  /** This method performs a copy of the XmlContents from the source 
      to the destination cursor.  */
  public void copyFromSourceToDestination(XmlCursor sourceCursor,
					  XmlCursor destinationCursor) {
   
    sourceCursor.copyXmlContents(destinationCursor);
  }

  
  /** This method copies the contents of the destination object as the
      last child within the source object. */
  public void 
  copyFromSourceToDestinationAsLastChild(XmlObject sourceObject,
					 XmlObject destinationObject) {
    if (sourceObject == null || destinationObject == null) {
      System.out.println(moduleName + "SourceObject=" + sourceObject + 
			 ", DestinationObject=" + destinationObject);
      return;
    }
    
    XmlCursor sourceCursor = sourceObject.newCursor();
    
    /** Proceed to position the destination cursor at the location just after 
	its last child element if there is one. */
    XmlCursor destinationCursor = destinationObject.newCursor();
    destinationCursor.toEndToken();
    //destinationCursor.toPrevToken();
    
    
    
    copyFromSourceToDestination(sourceCursor, destinationCursor);
    
    sourceCursor.dispose();
    destinationCursor.dispose();

  }



  /** This method copies the contents of the destination object as the
      first child within the source object. */
  public void 
  copyFromSourceToDestinationAsFirstChild(XmlObject sourceObject,
					  XmlObject destinationObject) {
    if (sourceObject == null || destinationObject == null) {
      System.out.println(moduleName + "SourceObject=" + sourceObject + 
			 ", DestinationObject=" + destinationObject);
      return;
    }

    XmlCursor sourceCursor = sourceObject.newCursor();
    
    /** Proceed to position the destination cursor at the location just after 
	its last child element if there is one. */
    XmlCursor destinationCursor = destinationObject.newCursor();
    destinationCursor.toFirstContentToken();
    //System.out.println(moduleName + "Moved to the first content content\n" +
    //destinationCursor.xmlText() + "\n"); 
    destinationCursor.toFirstChild();
    
    copyFromSourceToDestination(sourceCursor, destinationCursor);
    
    sourceCursor.dispose();
    destinationCursor.dispose();

  }
}
